feat(v28): Supporting Zod 4.4 by RobinTail · Pull Request #3364 · RobinTail/express-zod-api

RobinTail · 2026-04-30T12:33:28Z

adds xBrand() method to Zod Plugin instead of patching exiting one.
due to #3357

coderabbitai · 2026-04-30T12:33:35Z

Important

Review skipped

Auto reviews are disabled on base/target branches other than the default branch.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 9deb8bf2-bc0e-4990-b9ee-f2d57dd233ff

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

🔍 Trigger review

✨ Finishing Touches

🧪 Generate unit tests (beta)

Create PR with unit tests
Commit unit tests in branch support-zod44

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

…tead of patching brand().

socket-security · 2026-04-30T12:35:00Z

Review the following changes in direct dependencies. Learn more about Socket for GitHub.

Diff	Package	Supply Chain Security	Vulnerability	Quality	Maintenance	License
	zod@4.3.6 ⏵ 4.4.1	⁺¹		⁺¹	⁺⁸

View full report

coveralls-official · 2026-04-30T12:36:18Z

coverage: 100.0%. remained the same — support-zod44 into make-v28

pullfrog

Important

A few issues to address before merging.

Outside the diff (not commentable inline):

README.md lines 1105, 1254, 1269 still reference .brand() as the plugin's enhanced method. These should be updated to .xBrand() as part of this v28 work.
The zod-44-problem.md file appears to be a planning/scratch document. Consider whether it should be committed to the repo or removed before merge.
Zod 4.4 no longer populates jsonSchema.id from .meta({ id: "..." }), which causes the example's Feature schema to become Schema1 in the generated OpenAPI spec. The framework's documentation-helpers.ts:322-383 still reads depiction.id for naming components. This is a user-facing regression for anyone relying on .meta({ id }) for stable schema names in their docs — worth documenting in the CHANGELOG or compensating for in the framework.

Task list (5/5 completed)

Read the PR diff and understand the scope of changes
Examine high-risk areas: zod-plugin changes, runtime code
Examine CHANGELOG, documentation, and snapshot changes
Check zod-44-problem.md for context
Self-critique and submit review

^{｜ Fix all ➔ ｜ Fix 👍s ➔ ｜ View workflow run ｜ Using Claude Opus ｜ 𝕏}

pullfrog · 2026-04-30T12:56:26Z

Fixed the typo "distinguisable" → "distinguishable" in CHANGELOG.md as requested.

^{｜ View workflow run ｜ via Pullfrog ｜ Using Claude Opus ｜ 𝕏}

pullfrog · 2026-04-30T12:56:36Z

Fixed the typo ("intto" → "into") in express-zod-api/tests/env.spec.ts and pushed.

Task list (2/2 completed)

Fix typo "intto" → "into" in env.spec.ts
Commit, push, and reply to review comment

^{｜ View workflow run ｜ via Pullfrog ｜ Using Claude Opus ｜ 𝕏}

pullfrog

No new issues. Reviewed the following changes:

Added filterNaming in fixReferences to preserve user-defined schema names (from .meta({ id })) while filtering out Zod's auto-generated $defs keys (matching schema\d+$), fixing the component naming regression when depiction.id is no longer populated by Zod 4.4
Updated Zod from 4.3.6 to 4.4.1 and widened the peer/dev specifiers from ~4.3.4 to ^4.3.4/^4.4.1
Updated snapshots to reflect Zod 4.4 behavioral changes (CUID regex pattern, undefined optionality, removal of id from JSON schema output)

Prior review feedback:

Zod 4.4 depiction.id regression causing schema names to be lost — addressed via filterNaming fallback

^{｜ View workflow run ｜ Using Claude Opus ｜ 𝕏}

pullfrog · 2026-04-30T14:35:58Z

Acknowledged the author's fix in 2d3edc3 for the CHANGELOG grammar issue. Thread resolved — no further changes needed.

Task list (2/2 completed)

Review author's reply to CHANGELOG grammar comment
Acknowledge fix - no further changes needed

^{｜ View workflow run ｜ via Pullfrog ｜ Using Claude Opus ｜ 𝕏}

pullfrog

No new issues. Reviewed the following changes:

Updated README.md references from .brand() to .xBrand() at all three locations (plugin method list, brand handling prose, and code example)

Prior review feedback:

README.md lines 1105, 1254, 1269 still reference .brand() — addressed

^{｜ View workflow run ｜ Using Claude Opus ｜ 𝕏}

RobinTail · 2026-04-30T15:28:28Z

@pullfrog please review. Tell me if I'm missing something.

pullfrog

Reviewed — no issues found.

The changes are well-structured and handle the Zod 4.4 compatibility correctly:

fixReferences in documentation-helpers.ts — correctly adapts to Zod 4.4's change where .meta({ id }) no longer appears as a property in the JSON schema output but instead becomes the $defs key. The filterNaming regex correctly filters both schema0 and __schema0 auto-generated keys.
.brand() → .xBrand() rename — clean approach that avoids conflicting with Zod 4.4's native .brand() (which is now purely structural/type-level, not runtime). The simpler defineProperty with value (instead of the set/get accessor dance) is a nice cleanup.
No migration rule for .brand() → .xBrand() — this is the right call since Zod's native .brand() still exists and an automated rename could incorrectly transform legitimate native usages.
Snapshot changes (undefined?: undefined → undefined: undefined) — correctly reflects Zod 4's semantics where z.undefined() means "key must be present with value undefined", not "key is optional".

Re "am I missing something": I don't see anything missing. The CHANGELOG, README, plugin README, and plugin CHANGELOG are all consistent with the code changes. The diff block in CHANGELOG correctly shows only the changes covered by the automated migration tool.

Task list (4/4 completed)

Read the full diff to understand the scope of changes
Investigate high-risk areas (documentation helpers, zod-plugin changes, breaking changes)
Check for stale references or missing updates
Submit review

^{｜ View workflow run ｜ Using Claude Opus ｜ 𝕏}

RobinTail

🏁

Complements #3364

RobinTail added this to the v28 milestone Apr 30, 2026

RobinTail added enhancement New feature or request dependencies Pull requests that update a dependency file breaking Backward incompatible changes external bug it's a bug, but in a dependency labels Apr 30, 2026

RobinTail changed the title ~~feat(v28): Supporting Zod 4.4, …~~ feat(v28): Supporting Zod 4.4 Apr 30, 2026

feat(deps): Supporting Zod 4.4, add xBrand() method to Zod Plugin ins…

8b2f4ed

…tead of patching brand().

RobinTail force-pushed the support-zod44 branch from 7e474f9 to 8b2f4ed Compare April 30, 2026 12:34

pullfrog Bot reviewed Apr 30, 2026

View reviewed changes

Comment thread express-zod-api/tests/env.spec.ts

Comment thread CHANGELOG.md Outdated

Comment thread CHANGELOG.md

RobinTail commented Apr 30, 2026

View reviewed changes

Comment thread express-zod-api/tests/__snapshots__/documentation.spec.ts.snap Outdated

fixReferences: Using actualName as a fallback when it's meaningful.

a2f89b9

fix: typo in env.spec.ts test description

4de1dd8

pullfrog Bot reviewed Apr 30, 2026

View reviewed changes

changelog: grammar fix.

2d3edc3

pullfrog Bot and others added 2 commits April 30, 2026 14:38

fix: typo distinguisable → distinguishable

7de54eb

fix(docs): Updating Readme for using xBrand().

7d941ed

pullfrog Bot reviewed Apr 30, 2026

View reviewed changes

RobinTail mentioned this pull request Apr 30, 2026

v28 is for Koko Da Doll #3208

Open

pullfrog Bot reviewed Apr 30, 2026

View reviewed changes

RobinTail commented Apr 30, 2026

View reviewed changes

Comment thread zod-plugin/src/augmentation.ts Outdated

RobinTail added 2 commits April 30, 2026 17:46

fix(plugin): jsdoc: rm 'branded types' - those are no longer branded

d11768f

fix(jsdoc): rm 'branded schema' to 'schema braded with metadata'.

cfc0799

RobinTail commented Apr 30, 2026

View reviewed changes

RobinTail added the documentation Improvements or additions to documentation label Apr 30, 2026

RobinTail merged commit db72038 into make-v28 Apr 30, 2026
12 checks passed

RobinTail deleted the support-zod44 branch April 30, 2026 15:54

RobinTail mentioned this pull request Apr 30, 2026

fix(v28:plugin): Minor adjustments #3365

Merged

RobinTail added a commit that referenced this pull request May 1, 2026

fix(v28:plugin): Minor adjustments (#3365)

a2e5a6e

Complements #3364

Uh oh!

Conversation

RobinTail commented Apr 30, 2026

Uh oh!

coderabbitai Bot commented Apr 30, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Review skipped

Uh oh!

socket-security Bot commented Apr 30, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

coveralls-official Bot commented Apr 30, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

pullfrog Bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

pullfrog Bot commented Apr 30, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

pullfrog Bot commented Apr 30, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

pullfrog Bot left a comment

Choose a reason for hiding this comment

Uh oh!

pullfrog Bot commented Apr 30, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

pullfrog Bot left a comment

Choose a reason for hiding this comment

Uh oh!

RobinTail commented Apr 30, 2026

Uh oh!

pullfrog Bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

RobinTail left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

coderabbitai Bot commented Apr 30, 2026 •

edited

Loading

socket-security Bot commented Apr 30, 2026 •

edited

Loading

coveralls-official Bot commented Apr 30, 2026 •

edited

Loading

pullfrog Bot commented Apr 30, 2026 •

edited

Loading

pullfrog Bot commented Apr 30, 2026 •

edited

Loading

pullfrog Bot commented Apr 30, 2026 •

edited

Loading